Skip to content

docs(readme): refresh config and screening guidance#8

Merged
spignotti merged 1 commit intomainfrom
docs/readme-config-refresh
Mar 23, 2026
Merged

docs(readme): refresh config and screening guidance#8
spignotti merged 1 commit intomainfrom
docs/readme-config-refresh

Conversation

@spignotti
Copy link
Copy Markdown
Owner

Summary

  • update quickstart to copy litresearch.toml.example before running
  • update CLI example to include --overwrite
  • refresh config example with current defaults:
    • screening_selection_mode = \"top_percent\"
    • screening_top_percent = 0.3
    • screening_threshold = 60
    • s2_timeout = 10
    • s2_requests_per_second = 1.0
  • document screening selection modes (top_percent, top_k, threshold)
  • add relevant environment variables in README config section

Validation

  • uv run nox -s lint

Refresh quickstart and configuration examples for new screening
selection modes, Semantic Scholar throttling settings, and overwrite
usage. Add relevant environment variables for runtime configuration.
@spignotti spignotti merged commit f8f59a6 into main Mar 23, 2026
2 checks passed
@spignotti spignotti deleted the docs/readme-config-refresh branch March 23, 2026 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant